Skip to content

Add AI development guidelines and improve contribution docs#1148

Merged
daveearley merged 1 commit into
developfrom
chore/ai-dev-guidelines
Apr 6, 2026
Merged

Add AI development guidelines and improve contribution docs#1148
daveearley merged 1 commit into
developfrom
chore/ai-dev-guidelines

Conversation

@daveearley

Copy link
Copy Markdown
Contributor

What changes I've made

  • Added CLAUDE.md with trimmed, focused project conventions and dev guidelines (based on official best practices audit)
  • Added .claude/skills/translations/SKILL.md β€” moved translation workflow out of CLAUDE.md into an on-demand skill
  • Added AGENTS.md, .cursorrules, .github/copilot-instructions.md β€” all point to CLAUDE.md as single source of truth
  • Updated PR template with structured sections (what/why/how), closure warning, and pre-selected acknowledgement checkbox
  • Updated CONTRIBUTING.md with prior-discussion requirement and AI bot contributor guidelines (πŸ€– in PR titles and commits)
  • Removed CLAUDE.md from .gitignore so it's shared with the team

Why I've made these changes

  • CLAUDE.md was too long (358 lines) and not tracked in git β€” trimmed to 126 lines following official best practices
  • Contributors (especially AI bots) were leaving PR templates unedited β€” added clear warnings and structured sections
  • No guidance existed for Copilot or Cursor users β€” now all AI tools funnel to the same conventions

How I've tested these changes

  • Verified all referenced files/paths exist in the codebase (BaseAction, HtmlPurifierService, notifications, etc.)
  • Reviewed diffs for accuracy against current project patterns
  • Confirmed translations skill loads correctly

Checklist

  • I have read the contributing guidelines.
  • My code follows the coding standards of the project.
  • I have tested my changes, and they work as expected.
  • I understand that this PR will be closed if I do not follow the contributor guidelines and if this PR template is left unedited.

- Add CLAUDE.md with project conventions, architecture flow, and dev guidelines
- Add translations skill (.claude/skills/translations/SKILL.md)
- Add AGENTS.md and .cursorrules pointing to CLAUDE.md
- Add .github/copilot-instructions.md pointing to CLAUDE.md
- Update PR template with structured sections and closure warning
- Update CONTRIBUTING.md with AI bot requirements and prior-discussion policy
- Remove CLAUDE.md from .gitignore

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@railway-app

railway-app Bot commented Apr 6, 2026

Copy link
Copy Markdown

πŸš… Deployed to the Hi.Events-pr-1148 environment in Hi.Events

5 services not affected by this PR
  • Hi.Events Frontend
  • Redis
  • Postgres
  • Hi.Events API
  • Maildev

@daveearley daveearley merged commit bfcb246 into develop Apr 6, 2026
1 check passed
@daveearley daveearley deleted the chore/ai-dev-guidelines branch April 6, 2026 21:01
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 6, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant